<?php
namespace \Absidon\Controller\Uri;
/**
 * Interface that allows for telling if the class supports pretty URLs or is using Query Vars.
 *
 * @author Jacob Santos <webmaster@absidongames.com>
 * @since 0.1
 * @package Absidon
 * @subpackage Controller_Uri
 * @license Simplified BSD License <http://www.opensource.org/licenses/bsd-license.html>
 * @license GNU Lesser General Public License 2.1 or later <http://www.opensource.org/licenses/lgpl-2.1.php>
 */

/**
 * Tell other components that the URI class allows for matching a specific location.
 * 
 * Pretty URI components allow for matching the locations against a Regex.
 *
 * @since 0.1
 * @package Absidon
 * @subpackage Controller_Uri
 */
interface Pretty_Uri_Component
{
	/**
	 * Test regular expression against current pretty URI.
	 *
	 * If it passes, then it will return true. May also return an array if subclasses are used.
	 *
	 * @since 0.1
	 * @param string $regex Match location against regular expression.
	 * @returns bool|array
	 */
	public function match($regex);
}